Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: added additional version flag -v #1658

Merged
merged 4 commits into from
Feb 14, 2025

Conversation

Adi-204
Copy link
Contributor

@Adi-204 Adi-204 commented Feb 10, 2025

Description
Improves consistency with other CLI tools that offer both --version and -v options.

image

Related issue(s)
Fix: #1646

Copy link

changeset-bot bot commented Feb 10, 2025

⚠️ No Changeset found

Latest commit: f540cb8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Collaborator

@AayushSaini101 AayushSaini101 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Adi-204 Why we cannot use --v instead of using only -v ?

@Adi-204
Copy link
Contributor Author

Adi-204 commented Feb 13, 2025

@AayushSaini101 Sir -v is usually an industry standard for short flags in command-line interfaces, making it a more conventional and widely recognized choice. However, I can add support for --v as well if you want.
image
Sir and should I make changes in docs at https://github.com/asyncapi/cli/blob/master/docs/usage.md#usage add -v and --v in asyncapi --version?

@AayushSaini101
Copy link
Collaborator

https://github.com/asyncapi/cli/blob/master/docs/usage.md#usage

yes, you can mention in the usage section, and the - symbol we are using for the parameters in the commands so make sense to add -- check commands section for reference thanks : )

@Adi-204
Copy link
Contributor Author

Adi-204 commented Feb 14, 2025

image

@AayushSaini101 Sir should I change @asyncapi/cli/2.14.1 to @asyncapi/cli/2.16.1?

@AayushSaini101
Copy link
Collaborator

image

@AayushSaini101 Sir should I change @asyncapi/cli/2.14.1 to @asyncapi/cli/2.16.1?

@Adi-204 mention the latest released version thanks

@AayushSaini101
Copy link
Collaborator

/rtm

@asyncapi-bot asyncapi-bot merged commit 5becbe3 into asyncapi:master Feb 14, 2025
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[FEATURE] Add -v as shorthand for --version
3 participants